<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ObjectWrapper xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/com/googlecode/transloader/ObjectWrapper.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> com.googlecode.transloader;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> java.lang.reflect.InvocationHandler;
<a name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> java.lang.reflect.Method;
<a name="5" href="#5">5</a>   <strong class="jxr_keyword">import</strong> java.lang.reflect.Proxy;
<a name="6" href="#6">6</a>   <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a name="7" href="#7">7</a>   
<a name="8" href="#8">8</a>   <strong class="jxr_keyword">import</strong> com.googlecode.transloader.clone.CloningStrategy;
<a name="9" href="#9">9</a>   
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment">/**</em>
<a name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> * The wrapper appropriate for wrapping around all &lt;code&gt;Object&lt;/code&gt;s referencing &lt;code&gt;Class&lt;/code&gt;es from</em>
<a name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> * potentially foreign &lt;code&gt;ClassLoader&lt;/code&gt;s.</em>
<a name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * </em>
<a name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * @author Jeremy Wales</em>
<a name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../com/googlecode/transloader/ObjectWrapper.html">ObjectWrapper</a> {
<a name="17" href="#17">17</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Object wrappedObject;
<a name="18" href="#18">18</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../com/googlecode/transloader/clone/CloningStrategy.html">CloningStrategy</a> cloner;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment">	 * Constructs a new &lt;code&gt;ObjectWrapper&lt;/code&gt; around the given object, which will use the given</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment">	 * &lt;code&gt;CloningStrategy&lt;/code&gt; when required. Note that using implementation of {@link Transloader} is the</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment">	 * recommended way to produce these.</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment">	 * @param objectToWrap the object to wrap</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment">	 * @param cloningStrategy the strategy for cloning</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="28" href="#28">28</a>  	<strong class="jxr_keyword">public</strong> <a href="../../../com/googlecode/transloader/ObjectWrapper.html">ObjectWrapper</a>(Object objectToWrap, <a href="../../../com/googlecode/transloader/clone/CloningStrategy.html">CloningStrategy</a> cloningStrategy) {
<a name="29" href="#29">29</a>  		Assert.isNotNull(cloningStrategy);
<a name="30" href="#30">30</a>  		wrappedObject = objectToWrap;
<a name="31" href="#31">31</a>  		cloner = cloningStrategy;
<a name="32" href="#32">32</a>  	}
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">	 * Indicates whether or not &lt;code&gt;null&lt;/code&gt; is what is wrapped.</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment">	 * @return true if the wrapped "object" is actually &lt;code&gt;null&lt;/code&gt;</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="39" href="#39">39</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isNull() {
<a name="40" href="#40">40</a>  		<strong class="jxr_keyword">return</strong> wrappedObject == <strong class="jxr_keyword">null</strong>;
<a name="41" href="#41">41</a>  	}
<a name="42" href="#42">42</a>  
<a name="43" href="#43">43</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">	 * Provides direct access to the wrapped object.</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">	 * @return the actual wrapped object without any wrapping</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="48" href="#48">48</a>  	<strong class="jxr_keyword">public</strong> Object getUnwrappedSelf() {
<a name="49" href="#49">49</a>  		<strong class="jxr_keyword">return</strong> wrappedObject;
<a name="50" href="#50">50</a>  	}
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">	 * Indicates whether or not the wrapped object is an instance of the type with the given name in the wrapped</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">	 * object's &lt;code&gt;ClassLoader&lt;/code&gt;(s). It takes a parameter of type &lt;code&gt;String&lt;/code&gt; instead of</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">	 * &lt;code&gt;Class&lt;/code&gt; so that the test can be performed for &lt;code&gt;Class&lt;/code&gt;es that do not have an equivalent</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">	 * in the caller's &lt;code&gt;ClassLoader&lt;/code&gt;.</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">	 * @param typeName the name of the type against which the wrapped object will be checked</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">	 * @return true if the wrapped object is an instance of the type with the given name in the wrapped object's</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">	 *         &lt;code&gt;ClassLoader&lt;/code&gt;(s)</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="62" href="#62">62</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isInstanceOf(String typeName) {
<a name="63" href="#63">63</a>  		Assert.isNotNull(typeName);
<a name="64" href="#64">64</a>  		<strong class="jxr_keyword">return</strong> Transloader.DEFAULT.wrap(wrappedObject.getClass()).isAssignableTo(typeName);
<a name="65" href="#65">65</a>  	}
<a name="66" href="#66">66</a>  
<a name="67" href="#67">67</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">	 * Gets an equivalent of the wrapped object with all &lt;code&gt;Class&lt;/code&gt;es referenced being loaded from the given</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">	 * &lt;code&gt;ClassLoader&lt;/code&gt;. Every object referenced in the object graph starting with the object returned will</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">	 * be able to be cast to its respective types in the given &lt;code&gt;ClassLoader&lt;/code&gt;.</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">	 * &lt;p&gt;</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">	 * This implementation employs the &lt;code&gt;CloningStrategy&lt;/code&gt; configured at construction. Note that using</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">	 * {@link CloningStrategy#MINIMAL} (which is not the default strategy in {@link Transloader#DEFAULT}) will often</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">	 * effect some changes within the object graph that starts with the wrapped object itself, as opposed to producing a</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">	 * completely new, seperate graph. Using {@link CloningStrategy#MAXIMAL} instead prevents this, producing a purely</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">	 * seperate clone without any changes within the wrapped object graph, at the cost of potentially far greater</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">	 * cloning effort. An object graph altered by cloning with {@link CloningStrategy#MINIMAL} can of course be restored</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">	 * entirely for use with other objects of &lt;code&gt;Class&lt;/code&gt;es from its original &lt;code&gt;ClassLoader&lt;/code&gt;(s)</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">	 * by cloning it back with those original &lt;code&gt;ClassLoader&lt;/code&gt;(s), but this is an extra coding step and</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">	 * somewhat reduces the effort saved by not using {@link CloningStrategy#MAXIMAL} in the first place.</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">	 * &lt;/p&gt;</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">	 * @param classLoader the &lt;code&gt;ClassLoader&lt;/code&gt; to use in creating an equivalent of the wrapped object</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">	 * @return an equivalent of the wrapped object with all &lt;code&gt;Class&lt;/code&gt;es referenced being loaded from the</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">	 *         given &lt;code&gt;ClassLoader&lt;/code&gt;</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="87" href="#87">87</a>  	<strong class="jxr_keyword">public</strong> Object cloneWith(ClassLoader classLoader) {
<a name="88" href="#88">88</a>  		Assert.isNotNull(classLoader);
<a name="89" href="#89">89</a>  		<strong class="jxr_keyword">if</strong> (isNull()) <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="90" href="#90">90</a>  		<strong class="jxr_keyword">try</strong> {
<a name="91" href="#91">91</a>  			<strong class="jxr_keyword">return</strong> cloner.cloneObjectUsingClassLoader(getUnwrappedSelf(), classLoader);
<a name="92" href="#92">92</a>  		} <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="93" href="#93">93</a>  			<strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../com/googlecode/transloader/TransloaderException.html">TransloaderException</a>(<span class="jxr_string">"Unable to clone '"</span> + getUnwrappedSelf() + <span class="jxr_string">"'."</span>, e);
<a name="94" href="#94">94</a>  		}
<a name="95" href="#95">95</a>  	}
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">	 * Invokes on the wrapped object the method described by the given invocation description, with the parameters given</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">	 * by the same. Finds the method reflectively using parameter types loaded from the wrapped object's</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">	 * &lt;code&gt;ClassLoader&lt;/code&gt;(s). Any parameters which refer to &lt;code&gt;Class&lt;/code&gt;es that are foreign to the</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">	 * wrapped object's &lt;code&gt;ClassLoader&lt;/code&gt;(s) are cloned using the &lt;code&gt;CloningStrategy&lt;/code&gt; injected at</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">	 * construction.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">	 * </em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">	 * @param description the description of the invocation to be performed</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">	 * @return the result of performing the invocation described by &lt;code&gt;description&lt;/code&gt;</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">	 */</em>
<a name="107" href="#107">107</a> 	<strong class="jxr_keyword">public</strong> Object invoke(<a href="../../../com/googlecode/transloader/InvocationDescription.html">InvocationDescription</a> description) {
<a name="108" href="#108">108</a> 		Assert.isNotNull(description);
<a name="109" href="#109">109</a> 		<strong class="jxr_keyword">try</strong> {
<a name="110" href="#110">110</a> 			Class wrappedClass = getUnwrappedSelf().getClass();
<a name="111" href="#111">111</a> 			<em class="jxr_comment">// TODO collect all ClassLoaders from the object graph into an abstraction named CollectedClassLoader</em>
<a name="112" href="#112">112</a> 			ClassLoader wrappedClassLoader = wrappedClass.getClassLoader();
<a name="113" href="#113">113</a> 			Class[] parameterTypes = ClassWrapper.getClasses(description.getParameterTypeNames(), wrappedClassLoader);
<a name="114" href="#114">114</a> 			Object[] clonedParameters =
<a name="115" href="#115">115</a> 					(Object[]) cloner.cloneObjectUsingClassLoader(description.getParameters(), wrappedClassLoader);
<a name="116" href="#116">116</a> 			Method method = wrappedClass.getMethod(description.getMethodName(), parameterTypes);
<a name="117" href="#117">117</a> 			<strong class="jxr_keyword">return</strong> method.invoke(getUnwrappedSelf(), clonedParameters);
<a name="118" href="#118">118</a> 		} <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="119" href="#119">119</a> 			<em class="jxr_comment">// TODO test Exception from invoke</em>
<a name="120" href="#120">120</a> 			<strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../com/googlecode/transloader/TransloaderException.html">TransloaderException</a>(
<a name="121" href="#121">121</a> 					<span class="jxr_string">"Unable to invoke '"</span> + description.getMethodName() + Arrays.asList(description.getParameterTypeNames()) + <span class="jxr_string">"' on '"</span> + getUnwrappedSelf() + <span class="jxr_string">"'."</span>,
<a name="122" href="#122">122</a> 					e);
<a name="123" href="#123">123</a> 		}
<a name="124" href="#124">124</a> 	}
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a> 	<em class="jxr_javadoccomment">/**</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">	 * Makes an implementation of the given &lt;code&gt;interface&lt;/code&gt; that calls through to the wrapped object. This is</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">	 * particularly useful if you have access in the current &lt;code&gt;ClassLoader&lt;/code&gt; to an &lt;code&gt;interface&lt;/code&gt;</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">	 * that the wrapped object is expected to implement, except that it actually implements the equivalent from a</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">	 * different &lt;code&gt;ClassLoader&lt;/code&gt;. It is therefore usefully employed in conjunction with</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">	 * {@link #isInstanceOf(String)}.</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">	 * &lt;p&gt;</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">	 * This method will not fail fast if the wrapped object does not implement its own &lt;code&gt;ClassLoader&lt;/code&gt;'s</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">	 * equivalent to the given &lt;code&gt;interface&lt;/code&gt;, so can also be used for "duck"-typing, as a more syntactically</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">	 * elegant alternative to using {@link #invoke(InvocationDescription)}, if desired.</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">	 * &lt;/p&gt;</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">	 * </em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">	 * @param targetInterface the &lt;code&gt;interface&lt;/code&gt; that the returned object can be cast to</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">	 * @return a {@link Proxy} to the wrapped object that implements &lt;code&gt;desiredInterface&lt;/code&gt;</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">	 */</em>
<a name="141" href="#141">141</a> 	<strong class="jxr_keyword">public</strong> Object makeCastableTo(Class targetInterface) {
<a name="142" href="#142">142</a> 		Assert.isNotNull(targetInterface);
<a name="143" href="#143">143</a> 		<em class="jxr_comment">// TODO collect all ClassLoaders from the object graph into an abstraction named CollectedClassLoader</em>
<a name="144" href="#144">144</a> 		<strong class="jxr_keyword">return</strong> Proxy.newProxyInstance(getClass().getClassLoader(), <strong class="jxr_keyword">new</strong> Class[] {targetInterface}, <strong class="jxr_keyword">new</strong> Invoker());
<a name="145" href="#145">145</a> 	}
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a> 	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../com/googlecode/transloader/ObjectWrapper.html">Invoker</a> implements InvocationHandler {
<a name="148" href="#148">148</a> 		<strong class="jxr_keyword">public</strong> Object invoke(Object proxy, Method method, Object[] parameters) <strong class="jxr_keyword">throws</strong> Throwable {
<a name="149" href="#149">149</a> 			<strong class="jxr_keyword">return</strong> ObjectWrapper.<strong class="jxr_keyword">this</strong>.invoke(<strong class="jxr_keyword">new</strong> <a href="../../../com/googlecode/transloader/InvocationDescription.html">InvocationDescription</a>(method, parameters));
<a name="150" href="#150">150</a> 		}
<a name="151" href="#151">151</a> 	}
<a name="152" href="#152">152</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

